
 -----------------------------------------------------------------------------
|                              NECO README                                    |
 -----------------------------------------------------------------------------

Neco is the PC Engine emulator that i'm working on.
I'm student in Computer Science and was excited to the idea of developping
an emulator. Obviously, Neco won't fit to players but to developpers.

Neco is far, far to be perfect. My first version was released quite early 
to celebrate the 15th anniversary of the PC Engine.

As I like choosing special events to release Neco, here's a new release
for Christmas day. Consider it as a gift to PC Engine community !

I expect you'll enjoy Neco !

You will find below some informations to use Neco.

----------------------------
	Configuration
----------------------------

Neco has a configuration file (neco.cfg) that allows you to change 
some parameters.

  ----
  Keys
  ----

Each view has his own keys. I list below the keys for each view.
Remember that keys are available only on the view that has the focus.

Listing of the default keys:

 * Global

 Pause/Run  : F1
 Reset      : F2
 Fullscreen : F3
 Gamescreen : F4

 * Emulator view

 Up     : Up Arrow
 Down   : Down Arrow
 Right  : Right Arrow
 Left   : Left Arrow
 A      : Z
 B      : X
 Select : Space
 Run    : Enter

 * Execution view

 NextInstruction  : Space
 NextInstructions : Page Down

 * Tiles View

 Previous Palette           : Page Up
 Next Palette               : Page Down
 Switch to Sprite Tiles     : Right Arrow
 Switch to Background Tiles : Left Arrow

  ---------
  Execution
  ---------

This part is more intend to developpers.
In the section "ExecutionView", you can set some parameters that control
the execution of a ROM:
  - NbCycles       : this number is the number of instructions executed 
                     for a ROM before launching everything else
  - Breakpoint     : the emulator will execute the ROM before the PC reach
                     this address. This is done before everything else.


There are others features you can configure. Have a look to the file for more 
informations.

---------------------------------
	Technical Details
---------------------------------

I provide the sources of my project so, please, don't be too rude 
with my source code, i'm still a student and still have a lot of things 
to learn.
And don't consider all the warnings when you compile !
Bugs reports and comments are welcome.

Requirements
------------

Neco works with 2 librarires: 
  - SDL
  - Zlib

Linux
-----

You must have the SDL library installed with the binary 'sdl-config'
and the zlib library.
If so, typing "make" will create the binary neco.
Otherwise, you can get the sources of the SDL library at the
following address:
    http://www.libsdl.org/release/SDL-1.2.5.tar.gz
and the sources of zlib there:
    http://www.gzip.org/zlib/
Follow the instructions to install the libraries and you will be able
to work on Neco.
When installation successful, type "make" to create the binary neco.

Windows
-------

The directory VC6 contains the Visual C++ project files.
To work on the sources, you must install the SDL and Zlib libraries 
for Visual C++ at the following links:
    http://www.libsdl.org/release/SDL-devel-1.2.5a-VC6.zip
    http://www.gzip.org/zlib/
You must set the working directory to 
".....neco/src/" instead of "......neco/src/VC6/"
in the settings of the project
Menu: Project > Settings
                Debug 
                Working Directory
Well, no more informations are needed to work with Neco.

----------------------
	Contact
----------------------

Email        : kittie@noos.fr
Neco Website : http://www.epita.fr/~tching_v/dev/neco/
